Workbench Help

Topics

What is Workbench?

Release Notes

Creating a Game

The Project Settings Window

TADS 3 Documentation

TADS 3 Articles

Modifying Workbench

Modifying Workbench

Workbench has been written in a way that should make it easy for power users to modify various details. Apart from support for unrecognized options in project files (project files have the suffix ".t3m"), which can be modified in the Project Settings window, you can also modify the application itself.

To do this, the first step is always to Click on Workbench's icon in the Finder with the control key pressed (or with the right mouse button, if your Mac has one) to bring up the context menu. There, select Show Package Contents. In the window that appears, open the Resources folder in the Contents folder.

Feel free to look at the various text files in there. Many of them are very self-explanatory. Below is a list of the different files and some quick notes on modifying them.

DebugTadsScript.txtThis is the text for an AppleScript script that launches the TADS debugger (when you choose Build and Debug). The file name of the debugger will be inserted at the location of the first "%@", the one of the file to run at the second. Also note that the file name has already been escaped for the command line *and* AppleScript. If you have a GUI debugger, you'll very likely want to use the open command in Terminal to open it from this script.
SyntaxDefinition.plistThis file contains a list of all identifiers to colorize in source files, as well as of preprocessor directives etc. You need Apple's "Property List Editor" (part of the Developer Tools) to edit it.
OtherConfig.txtThis file is used to retrieve default values for the Other Configuration section in newly created projects' settings.
OtherOptions.txtThis file is used to retrieve default values for the Other Options section in newly created projects' settings.
Preferences.plistThis is a file containing the default settings for various preferences. See below for a listing of all preferences supported by Workbench.
RunTadsScript.txtThis is the text for an AppleScript script that launches the TADS interpreter (when you choose Build and Run). The file name of the interpreter will be inserted at the location of the first "%@", the one of the file to run at the second. Also note that the file name has already been escaped for the command line *and* AppleScript. If you have a GUI debugger, you'll very likely want to use the open command in Terminal to open it from this script.
t3includeThis folder contains the TADS 3 headers. This is straight from the official TADS distribution.
t3libraryThis folder contains the TADS 3 adv3 library that implements Actors, Things, Fixtures, the parser, etc. This is straight from the official TADS distribution.
t3makeThis is the actual TADS 3 compiler used when compiling applications. It is simply the t3make command line tool, straight from the TADS Unix distribution.
t3resourceThis folder contains character mappings to make sure text is output the right way. This is straight from the official TADS distribution.

Preferences

Workbench stores preferences in the standard User Defaults format. This means you can edit and create Preferences files using Apple's Property List Editor or using the defaults command.

SyntaxColoring:CommentsThis is the color to use for comments when doing syntax coloring on text files. They are simply stored as an array of three numbers for Red, Green and Blue, where 1.0 means full color, and 0.0 means none of that color.
SyntaxColoring:IdentifiersThis is the color to use for identifiers when doing syntax coloring on text files.
SyntaxColoring:PreprocessorThis is the color to use for preprocessor directives (#include etc.) when doing syntax coloring on text files.
SyntaxColoring:StringsThis is the color to use for strings when doing syntax coloring on text files.
Tads:InterpreterThis is the search path to the TADS interpreter to use for running games. By default, this is the copy of t3run embedded in Workbench.
Tads:DebuggerThis is the search path to the TADS debugger to use for debugging games. By default, this is simply "t3dbg", which means you have to install the command-line debugger to use it.